/*
 * Copyright (c) 2010-2025. Axon Framework
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.axonframework.updates.api;

import jakarta.annotation.Nonnull;
import org.axonframework.common.annotation.Internal;

/**
 * Represents a vulnerability in an AxonIQ Artifact in use. This record contains information about the
 * artifact's group ID, artifact ID, severity of the vulnerability, the recommended fix version, and a description of the
 * vulnerability.
 *
 * @param groupId     The group ID of the artifact.
 * @param artifactId  The artifact ID of the artifact.
 * @param severity    The severity of the vulnerability, represented by the {@link DetectedVulnerabilitySeverity}
 *                    enum.
 * @param fixVersion  The recommended version to fix the vulnerability.
 * @param description A description of the vulnerability, providing details about its nature and impact.
 * @author Mitchell Herrijgers
 * @since 5.0.0
 */
@Internal
public record DetectedVulnerability(
        @Nonnull String groupId,
        @Nonnull String artifactId,
        @Nonnull DetectedVulnerabilitySeverity severity,
        @Nonnull String fixVersion,
        @Nonnull String description
) {

}
